fix(graphql): rename mutation response wrapper on output-type name collision#55
Merged
Merged
Conversation
…llision
The mutation response wrapper is normally named "{trainName}Response". When a
user's output CLR class happens to be named "{trainName}Response" (e.g.
IAddressValidationTrain returning AddressValidationResponse), HotChocolate gets
two type registrations claiming the same GraphQL name and schema build fails.
Detect the collision against the set of output ObjectType names and fall back
to "{trainName}MutationResponse" so the schema can build. Trains whose output
types follow a different naming convention are unaffected.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
This PR is included in version 1.30.1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The mutation response wrapper is normally named
{trainName}Response. When a user's output CLR class happens to be named{trainName}Response(e.g.IAddressValidationTrainreturningAddressValidationResponse), HotChocolate gets two type registrations claiming the same GraphQL name and schema build fails with "type registered twice."The fix detects the collision against the set of output
ObjectTypenames and falls back to{trainName}MutationResponse. Trains whose output types follow a different naming convention are unaffected.The collision needs three things to line up: the train's derived name ends right before where
Responsewould go, AND the user's output CLR class is literally named{TrainName}Response. Easy footgun becauseFooResponseis a common convention for output DTOs andIFooTrain→Foois the standard derivation.Test plan
TrainTypeModuleTests.csunderResponse Type Name Collisionregion:IRequestExecutorResolversucceeds (the actual failure mode){trainName}Responsename preserved